home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / PROGRAMR / HDK100L.ZIP / HDKLIB.DOC next >
Text File  |  1993-12-09  |  14KB  |  300 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                               P.O.Box 5517                               ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. *******************************************************************************
  12. *                                   HDKLIB                                    *
  13. * HLPDK V10.0+ System Library Documentation.                                  *
  14. * Last Update - Dec. 09, 1993. (c) 1993, Loewy Ron.                           *
  15. *******************************************************************************
  16.  
  17.  HLPDK V10.0+ System Extention Library.
  18.  
  19.  "Write Once, Help Many!"
  20.       
  21. *******************************************************************************
  22. *                                  File-List                                  *
  23. *******************************************************************************
  24.  
  25. This package contains the following files :
  26.  
  27. HDKLIB  .DOC    - This file.
  28. HDKLIB  .HDF    - System extention library HDF source.
  29. VWRLIB  .HDF    - System extention library component. (MM Viewer specific).
  30. RTFLIB  .HDF    - System extention library component. (Common RTF extentions).
  31. IPFLIB  .HDF    - System extention library component. (OS/2, needs HLPDK V11.0)
  32. TESTLIB .HDF    - A Small test for the library - Source.
  33. TESTLIB .HLP    - A Small test for the library - WINHELP format.
  34. PRS     .BMP    - A Bitmap used in the test.
  35.  
  36. *******************************************************************************
  37. *                                Introduction                                 *
  38. *******************************************************************************
  39.  
  40. HDKLIB is an extention library to HLPDK V10.0+ that adds functionality to
  41. the HLPDK package, by including special "User Link Templates" that add support
  42. for special links, special graphics, enhanced text attributes and more.
  43.  
  44. HDKLIB uses the HLPDK .USERLINK statement to add functionality to the HLPDK
  45. system, and offer simple methods to create graphic links, normal text links,
  46. 256 color bitmap support, video, CDAudio, Multimedia MCI interface etc ..
  47.  
  48. WINHELP users have access to the complete macro API, using !xxx user links.
  49.  
  50. *******************************************************************************
  51. *                                  Warranty                                   *
  52. *******************************************************************************
  53.  
  54. There is no warranty what so ever, The package is supplied as is,
  55. The distributor (ISoft D&M), or the author (Loewy Ron), are not, 
  56. and will not be responsible for any damages, lost profits, 
  57. or inconveniences caused by the use, or inability to use this package. 
  58. The use of the program is at your own risk. 
  59. By using (or attempting to use) the package you agree to this.
  60.  
  61. *******************************************************************************
  62. *                                Distribution                                 *
  63. *******************************************************************************
  64.  
  65. HDKLIB is free to registered users of HLPDK. If you are not a HLPDK registered
  66. user, you are allowed to evaluate HLPDK and HDKLIB for a reasonable amount of
  67. time (Up to 1 Month).
  68.  
  69. Please consult the HLPDK.DOC and HLPDK.REG files that come with the evaluation
  70. package of HLPDK.
  71.  
  72. *******************************************************************************
  73. *                                   Contact                                   *
  74. *******************************************************************************
  75.  
  76. Please contact :
  77.  
  78.         ISoft D&M  
  79.         P.O.Box 5517
  80.         Coralville IA 52241
  81.         U.S.A
  82.  
  83.         E-Mail  : Compuserve - 76350,333
  84.         Phone   : (319) 351-8413
  85.            
  86. To contact the author directly please write to : 
  87.  
  88.         Loewy Ron
  89.  
  90.         E-Mail  : Compuserve - 100274,162
  91.  
  92. *******************************************************************************
  93. *                                    Setup                                    *
  94. *******************************************************************************
  95.  
  96. Copy the files to the directory you use to keep HLPDK V10.0+ .
  97.  
  98. Every help/hypertext/hypermedia database you use with HDKLIB should include
  99. a line of the format :
  100.  
  101. .include [d:\path\to\hdklib-directory\]HDKLIB.HDF
  102.  
  103. and all the HDKLIB functions are available.
  104.  
  105. *******************************************************************************
  106. *                                  Operation                                  *
  107. *******************************************************************************
  108.  
  109. After you have .INCLUDEd the HDKLIB.HDF library in your HDF source, you
  110. can use the following NEW functions and templates :
  111.  
  112. winHelp
  113. -------
  114.  
  115. Text Attributes :
  116.  
  117. boldText        - Display Text in Bold.     ~Text to display~boldText~
  118. italicText      - Display Text in Italic    ~Text to display~italicText~
  119. underlineText   - Display Text underlined   ~Text to display~underlineText~
  120. boldItalicText  - Display Bold Italic Text  ~Text to display~boldItalicText~
  121. fontText        - Display Text in font X    ~Text in font 3~fontText(3)~
  122.  
  123. Links :
  124.  
  125. NormalTextLink  - Link not underlined       ~Click Here~NormalTextLink(linkId)~
  126. NormalTextPopup - Popup not underlined      ~Click Here~NormalTextPopup(popupId)~
  127.  
  128. graphicLink     - Link connected to bitmap  ~Text~graphicLink(myBmp LinkId)~
  129.                   Should declare a .GRAPHIC myBmp c:\..\myfile.bmp
  130. graphicPopup    - Popup connected to bitmap ~Text~graphicPopup(myBmp PopupId)
  131.                   Should declared a .GRAPHIC myBmp c:\..\myfile.bmp
  132.  
  133.  
  134. Macros :
  135.  
  136. Complete WINHELP macro API reference is provided, if there is a macro such
  137. as the About() WINHELP macro, you can rfer to it with the !about user link.
  138.  
  139. e.g. - Using the ExecProgram WINHELP macro, to start NOTEPAD.EXE in minimized
  140.        mode can be used with !execProgram(notepad.exe 2)
  141.  
  142. For the complete macro reference, please consult the WINHELP macro 
  143. documentation in the programming reference guide that came with your
  144. development package, or the Microsoft WHAG package.
  145.  
  146. WINHELP Macros Quick Referece -
  147.  
  148. About                - Displays the About dialog box 
  149.                       e.g. ~text~!about~      
  150. AddAccelerator        - Assigns a macro to an accelerator key 
  151.                       e.g. ~text~!addAccelerator(0x73 7 'About()')~
  152. Annotate        - Displays Annotation dialog box 
  153.                       e.g. ~text~!annotate~
  154. AppendItem        - Appends a menu item 
  155.                       e.g. ~text~!appendItem(ID_MENU ID_ITEM &Item 'JI("","TOP")'~
  156. Back                - Displays previous topic in the history list 
  157.                       e.g. ~text~!back~
  158. BookmarkDefine        - Displays the Define dialog box 
  159.                       e.g. ~text~!bookmarkDefine~
  160. BookmarkMore        - Displays the More dialog box 
  161.                       e.g. ~text~!bookmarkMore~
  162. BrowseButtons        - Adds browse buttons 
  163.                       e.g. ~text~!browseButtons~
  164. ChangeButtonBinding - Assigns a macro to a button 
  165.                       e.g. ~text~!ChangeButtonBinding(btn_contents 'JI("","NEWTOP")')~
  166. ChangeItemBinding   - Assigns a macro to a menu item 
  167.                       e.g. ~text~!changeItemBinding(DISP_ABOUT About())~
  168. CheckItem        - Checks a menu item 
  169.                       e.g. ~text~!checkItem(ID_ITEM)~
  170. CloseWindow        - Closes a window 
  171.                       e.g. ~text~!closeWindow(ID_WIN)~
  172. Contents        - Displays the Contents topic                             
  173.                       e.g. ~text~!contents~
  174. CopyDialog        - Displays the Copy dialog box 
  175.                       e.g. ~text~!copyDialog~